COMMIT 컨벤션 가이드
NOTE
프로젝트 Git 커밋 메시지 작성 규칙(태그·헤더·본문 형식) 가이드.
이 문서는 프로젝트의 Git 커밋 메시지 작성 규칙을 정의합니다.
모든 커밋은 아래의 규칙을 준수하여 작성해 주시기 바랍니다.
📌 가이드 내용
1. 기본 형식 (Format)
커밋 메시지는 헤더(Header), 빈 줄, 본문(Body) 으로 구성됩니다.
2. 태그 종류 (Type)
헤더의 <Type>에는 변경 사항의 성격을 나타내는 태그를 사용합니다.
| 태그 (Type) | 설명 |
|---|---|
| feat | 새로운 기능 추가 |
| fix | 버그 수정 |
| docs | 문서 수정 |
| style | 코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등 로직 변경 없음) |
| design | 사용자 UI 디자인 변경 (CSS 등) |
| test | 테스트 코드 추가/수정, 리팩토링 (Test Code) |
| refactor | 리팩토링 (기능 변경 없이 코드 구조 개선 - Production Code) |
| build | 빌드 파일 수정 |
| ci | CI 설정 파일 수정 |
| perf | 성능 개선 |
| chore | 자잘한 수정이나 빌드 업데이트 (소스 코드 변경 없음) |
| rename | 파일 혹은 폴더명을 수정만 한 경우 |
| remove | 파일을 삭제만 한 경우 |
3. 작성 규칙 (Rules)
헤더 (Header)
- 명령문 사용: 제목은 명령문의 형태로 작성합니다. (동사 원형 사용)
- 마침표 금지: 제목의 끝에는
.(마침표)를 찍지 않습니다.
본문 (Body)
- 공백 분리: 헤더와 본문 사이에는 반드시 **한 줄(Blank line)**을 띄워줍니다.
- 목록 형식: 본문의 각 내용은 (대쉬)로 구분하여 작성합니다.
- 내용: ‘무엇을’, ‘왜’ 변경했는지 간단히 기재합니다.
4. 작성 예시 (Example)
feat : CommonUtil 해시 생성 공통 메서드(makeHash) 추가
- 중복되는 SHA256 해시 생성 로직을 공통 유틸리티로 중앙화
- TreeMap을 활용하여 Map 키의 대소문자 무시 처리 및 SnakeCase 호환성 지원
- goodsAmt 누락 시 기본값('0') 처리 로직 내장
관련 문서
- [(Git) 브랜치 관리 전략 (Branch Management Guide) - 핵심 개념 및 특징 정리](./[Git]%20브랜치%20관리%20전략%20(Branch%20Management%20Gu%20-%20핵심%20개념%20및%20특징%20정리.md) — 같은 회사 Git 워크플로에서 커밋 컨벤션과 짝을 이루는 브랜치 네이밍/MR 작성 규칙
- (Git) 오픈소스 기여 방법 및 순서 — 이 회사 Conventional Commits 규칙을, 타입 접두사를 쓰지 않는 오픈소스(GlueSQL 등) 커밋 관례와 대비시켜 설명하는 노트